Shareware Grab Bag

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Grab Bag / Shareware Grab Bag.iso / 090 / 3by5.arc / 3BY5.DOC next >

Wrap

Text File | 1984-11-12 | 141.3 KB | 3,895 lines

3by5 Version 1.0 OWNERS MANUAL Written for the IBM PC and XT (c) Copyright 1984 Softshell Corp. TABLE OF CONTENTS CHAPTER 1. INTRODUCTION 1.1 Overview of 3by5 for the PC .................... 1-1 1.2 Potential uses of 3by5 ......................... 1-1 CHAPTER 2. GETTING STARTED 2.1 Notation Used in the 3by5 Manual ............... 2-1 2.2 Equipment Needed to Run 3by5 ................... 2-2 2.3 Files on the 3by5 diskette ..................... 2-3 2.4 Installation Procedures ........................ 2-4 CHAPTER 3. TRAINING LESSONS ............................... 3-1 LESSON 1 - Searching 3by5 Files ................ 3-1 LESSON 2 - Creating and Editing 3by5 Files ..... 3-7 LESSON 3 - Printing and Outputing to Files ..... 3-13 LESSON 4 - Multiple Windows and Files .......... 3-16 CHAPTER 4. 3by5 COMMANDS 4.0 MAIN COMMAND MENU .............................. 4-1 4.1 FILE COMMANDS .................................. 4-1 4.1.1 OPEN COMMAND ................................. 4-2 4.1.1.1 Creating a 3by5 File ...................... 4-3 4.1.1.2 Indexing a File ........................... 4-3 4.1.1.3 Opening a Non-3by5 File ................... 4-4 4.1.1.4 Opening an Output File .................... 4-4 4.1.1.5 Closing Files ............................. 4-5 4.1.2 INFO COMMAND ................................. 4-5 4.1.3 DIR COMMAND .................................. 4-6 4.1.4 PATH COMMAND ................................. 4-6 4.1.5 COPY AND MOVE COMMANDS ....................... 4-7 4.2 SEARCH COMMANDS ................................ 4-8 Single Search Keys ........................... 4-9 Multiple Search Keys ......................... 4-10 4.3 WINDOW COMMANDS ................................ 4-10 4.3.1 Clear Command ............................... 4-10 4.3.2 Set Command ................................. 4-10 4.3.3 Direct Command .............................. 4-11 4.3.4 Format Command .............................. 4-11 4.4 MODIFY COMMANDS ................................ 4-13 4.4.1 Add Command ................................. 4-13 4.4.2 Edit Command ................................ 4-14 4.4.3 Insert Command .............................. 4-14 4.4.4 Copy and Move Commands ...................... 4-14 4.4.5 Delete Command .............................. 4-15 4.5 PRINT COMMAND .................................. 4-16 4.5 EXIT COMMAND ................................... 4-16 CHAPTER 5. RECORD COMMANDS 5.1 RECORD COMMANDS ................................ 5-1 5.1 Search Command ................................ 5-1 5.2 Edit Command .................................. 5-1 5.3 Forward and Backward Commands ................. 5-1 5.4 Goto Command .................................. 5-2 5.5 Print Commmand ................................ 5-2 5.6 Write Command ................................. 5-2 5.7 Quit Command ................................. 5-2 CHAPTER 6. THE 3by5 EDITOR 6.1 Adding Text ................................... 6-1 6.2 Deleting Text a character at a time ........... 6-1 6.3 Inserting Text a character at a time .......... 6-1 6.4 Back Space .................................... 6-2 6.5 Moving the Cursor ............................. 6-2 6.6 Edit Command Menu ............................. 6-2 6.6.1 Saving a record ............................. 6-3 6.6.2 Defining text ............................... 6-3 6.6.2.1 Copying a block of text ................... 6-3 6.6.2.2 Moving a block of text .................... 6-4 6.6.2.3 Erasing a block of text ................... 6-4 6.6.3 Inserting a predefined block of text ........ 6-4 6.6.4 Format (Right Margin) Command ............... 6-4 6.6.5 Search Command .............................. 6-4 6.6.6 Printing a record ........................... 6-4 6.6.7 Abort Command ............................... 6-5 FUTURE SOFTSHELL RELEASES WARRANTY INDEX REGISTRATION FORM INTRODUCTION CHAPTER 1. INTRODUCTION 1.1 Overview of 3by5 for the PC 3by5 is an information management program that offers speed, simplicity and versatility in entering, indexing and retrieving free-text and structured data. It is as simple to use as a 3x5 card file. Entering information is simple. You may use 3by5's integrated word processor or any other word processor, text editor or computer program to enter data in any format: words, phrases, sentences, paragraphs or fixed files. Searching files is fast, thanks to 3by5's unique indexing method (signature screening). Just enter a SEARCH key (any combination of 3 to 60 characters) and 3by5 will find the first and all subsequent occurences of the key in your file. Moreover, when the key is found, it is displayed in the context of the sentence or record in which it appears. As each occurence is found, you have the option of continuing the search, editing the record, printing the infromation, transfering records from one file to another, or ending the search. You may search for partial keys, i.e. an incomplete word or phrase. For example, the search key "CDONA" will locate the name "McDonald" and "MacDonald". You may also search for combin- ations of key terms which appear in the same sentence or record (up to 1024 characters long) by using the conjunctions "and" (symbol = "&") or "or" (symbol = "|"). For example, "basic&cobol&ibm|pascal&compaq" will locate records which contain the words "Basic", "Cobol" and "IBM" or the words "Pascal" and "Compaq". 3by5 allows you to search and edit up to three files at a time in addition to one ASCII output file. 3by5 also allows you to search standard ASCII files, and WordStar and WordPerfect Document files. The ability to search and edit multiple files is aided by 3by5's multiple windows. For example, while editing in one window, you may search in another. 1.2 Potential uses of 3by5 3by5 will satisfy any need for quick entry, indexing and retrieval of free-text data. 3by5 has proven valuable in such tasks as: Indexing personal literature collections. Quickly searching client or patient records. Card catalogs for small libraries. Mailing lists. Cataloging and cross-referencing research notes. 1-1 GETTING STARTED CHAPTER 2. GETTING STARTED 2.1 Notations used in the 3by5 Owner's Manual [xxxxx] Square brackets enclose characters you type at the keyboard. <Enter> Press the Enter key. <Esc> Press the Escape key (labeled Esc). <Del> Press the Delete key (labeled Del). <Ins> Press the Insert key (labeled Ins). <PgUp> Press the Page Up key (labeled PgUp). <PgDn> Press the Page Down key (labeled PgDn). <Ctrl> Hold the control key (labeled Ctrl) while pressing another key. _____________________________________________________ | | | Any text enclosed in a box represents text | | shown on the video screen | |_____________________________________________________| "|" The OR character. For example, "dog|cat" means "dog" or "cat". "&" The AND character. For example, "dog&cat" means "dog" and "cat". Note: The characters * ? + cannot be used in a search key, they are reserved for future use. 2-1 GETTING STARTED 2.2 Installation Procedures 2.2.1 Equipment Needed to Run 3by5 IBM PC, PC/XT, Compaq or 100% IBM compatible. 192K RAM and at least one disk drive. (A special version is available for 128K machines) PC DOS Version 2.0 or higher An IBM or Epson dot matrix printer is optional 2.2.2 Files of the 3by5 diskette The dual sided, double density diskette 3by5 Master Diskette contains the following files: 3BY5.EXE The main 3by5 program. It is a machine language program and has no overlay routines. It may be removed from the disk drive after 3by5 is loaded into memory. SAMPLE1.3X5, SAMPLE2.3x5, SAMPLE3.WP and SAMPLE4.WS Four sample text files. SAMPLE1.MAP, SAMPLE2.MAP, SAMPLE3.MAP and SAMPLE4.MAP Four companion index files for the sample files. PRINTALL.BAT Batch file to print all 3by5 document files. CHAP1&2.DOC, CHAP3.DOC, CHAP4&5.DOC, and CHAP6.DOC The four 3by5 document files. They are standard ASCII files. README Introduction: describes how to print documenation. 2.2.3 INSTALLING 3by5 2.2.3.1 MAKING A BACK-UP COPY OF THE 3by5 MASTER DISKETTE 1. Place a DOS system diskette into drive A and turn on the computer. 2. If asked, enter the data and time. 3. Place a new or blank diskette in drive B. 4. Type [format b: /s] <Enter>. This will format the diskette in drive B and add the DOS operating system to the diskette. Make certain that the diskette in drive B is new or 2-2 GETTING STARTED has no files that you want to save. 5. Remove the DOS system diskette from drive A and insert the 3by5 Master Diskette in drive A. Leave the newly formatted diskette in drive B. 6. Type [copy a:*.* b:] <Enter>. This will copy all the 3by5 files onto your newly formatted diskette in drive B. Use this diskette as your working copy of the 3by5 Master Diskette. NOTE TO SINGLE DISK DRIVE OWNERS: The DOS operating system treats the single, physical disk drive as two logical drives. DOS will prompt you when to exchange diskettes during the formatting and copying procedures. 2.2.3.2 MAKING A WORKING COPY OF THE 3by5 PROGRAM The only file you need to run the 3by5 program is 3BY5.EXE. You may copy it onto any diskette (system or data type) or hard disk. For diskette based systems, the simplest method is to format a DOS system diskette as described in section 2.2.3.1. Then place your backup copy of the 3by5 Master Diskette in drive A, the newly formatted diskette in drive B, and type: [copy a:3by5.exe b:] <Enter>. 2.2.3.3 LABELING AND STORING 3by5 DISKETTES When the installation process is complete, remove the 3by5 Master Diskette from drive A and store it in a safe location. It will be your master backup copy in the event of a disaster. Label the diskette onto which you have just transferred the 3by5 files with the following: 3by5 Version 1.0 (C) Softshell Corp. All subsequent copies of the 3by5 programs should also be labeled with the 3by5 title and the Softshell Corp. copyright notice. 2-3 LESSONS CHAPTER 3. TRAINING LESSONS LESSON 1 - Searching 3by5 Files In this lesson you will learn how to search a 3by5 text file. We will use file SAMPLE1, which contains 50 scientific and medical references in various formats. Each record (think of each record as a 3x5 card) in the file contains one reference. 3by5 FILES 3by5 stores your text in files on hard disk or diskette. 3by5 files come in pairs: a SOURCE FILE that contains text and a companion INDEX FILE that allows you to rapidly search your largest source file. 3by5 source files have the extension "MAP". Before you can work with a 3by5 file you must open it. 3by5 allows you to open, search and edit up to three files at a time. The files you open are referred to as PRIMARY, SECONDARY and TERTIARY files. The terms are simply for convenience in issuing commands and referring to the open files. You may open or close a file in any order and at any time. For example, you may open a secondary file first and then open a primary file. Step 1 - Loading the Program Insert the DOS system diskette onto which you have copied the 3by5 files in drive A (see Installing 3by5 on page 2-2). Turn on the computer or reset it by pressing the Ctrl, Alt and Del keys simultaneously if the DOS prompt "A>" is not present. Enter the date and time if asked. A NOTE TO HARD DISK USERS: For these lessons we will use only drive A with the system booted to drive A. Step 2 - Starting 3by5 When the "A>" prompt appears, type [3by5] <Enter>. The program will be loaded into memory and the 3by5 Title Screen displayed: 3-1 LESSONS _____________________________________ | | | | | 3by5 | | | | | | SOFTSHELL Corp. | | (c) Copyright 1984 | |_____________________________________| Press any key to continue Step 3 - Main Command Menu After the 3by5 Title Screen is displayed, press any key to continue and the Main Command Menu will appear at the top of the screen: ___________________________________________________ |Files: | |Search Window Modify >Files< Print Exit | |Open Info Dir Path Copy Move | |___________________________________________________| The top line is blank except for the message "Files:". It will contain the name of files that are open. The second line contains the commands that may be executed. The third line (Auto Help Line) is highlighted, i.e. displayed in reverse video. It gives you information on the current command. On the second line the command FILES is highlighted (depicted in this documentation by being enclosed by >< signs). The area in reverse video is called the Command Indicator. Press the space bar once and the command FILES will appear in standard video and the command PRINT will be highlighted. Press the space bar again and the EXIT command will be high- lighted. You may move the Command Indicator by pressing the space bar, left or right arrow keys or back space key. You may execute a command by positioning the Command Indicator on the command and pressing <Enter> or by pressing the first letter of the command you want, regardless of where the Command Indicator is located. We need to open a file so we will use the FILES command. Press [F] to execute the FILES command. 3-2 LESSONS Step 4 - Opening Files The File Command Menu will appear: ___________________________________________________ |Files: | |>Open< Info Dir Path Copy Move | |Open: Primary Secondary Tertiary Output file | |___________________________________________________| The Auto Help Line informs you that you may open a Primary, Secondary, Tertiary or Output file. Press [O] to open a file and the following prompt will appear: ___________________________________________________ |Files: | |Open Primary File | |FILE NAME: | |___________________________________________________| The cursor will be blinking; waiting for you to enter the name of the file you want to open. Type [sample1] <Enter> to open the first sample file. Remember, type only the characters within the square brackets [], but not the brackets. The message "WAIT" will be displayed in reverse video in the upper right corner of the screen while the file is being opened. If there were any errors in opening the file, the program will inform you of the problem, wait for you to press <Enter> and then allow you to reenter the file name. After the source and index files have been opened, the Main Command Menu will appear again: ___________________________________________________ |Files: P[sample1.3x5] | |Search Window Modify >Files< Print Exit | |Open Info Dir Path Copy Move | |___________________________________________________| On the top line the message "Files: P[sample1.3x5]" informs you that you have opened a Primary File called SAMPLE1. Since it is a 3by5 file, it has the extension "3x5". 3-3 LESSONS Step 5 - Searching a File The Main Command Menu should appear as below: ___________________________________________________ |Files: P[sample1.3x5] | |Search Window Modify >Files< Print Exit | |Open Info Dir Path Copy Move | |___________________________________________________| You are now ready to search the file. Press [S] and the following screen will appear: ___________________________________________________ |Files: P[sample1.3x5] | |Enter Key: | |Press <Esc> for Menu; <F3> prior key; <F4> browsing| |___________________________________________________| The message "Enter Key" is a prompt to inform you that the program is ready to accept a search key. A key is any word, partial word, phrase or number that is 3 to 60 characters in length. As you will see, you may also search for combinations of keys. The Auto Help Line informs you that you may press the F3 function key to display the previous search key (if any) or the F4 function key to browse (i.e. move forward and backward through the file without regard to search key). Press <Esc> once and the Main Command Menu will be displayed again: ___________________________________________________ |Files: P[sample1.3x5] | |>Search< Window Modify Files Print Exit | |Search: P[sample1.3x5] All | |___________________________________________________| You are now back at the Main Command Menu. The <Esc> key is used to exit from the Search Command. Press [S] to continue the search and the "Enter Key:" prompt will appear again. You are now ready to start your search for words, phrases, 3-4 LESSONS etc. Step 6 - Finding Single Keys We will search all references in file SAMPLE1 that have the author's name "Victor McKusick". Type [mckusick] <Enter> in response to the "Enter key:" prompt. Note that 3by5 ignores capitalization. The message "Searching" will be displayed on the third line of the screen to indicate the action the program is taking. The first article written by McKusick will be found, and the record will be displayed. 3by5 displays a record at a time and waits for instructions from you before continuing. At the BOTTOM of the screen the Record Command Menu will be displayed: _____________________________________________________ |>Search< Edit Forward Backward Goto Print Write Quit | |Continue search | |_____________________________________________________| IN GENERAL, 3by5 COMMAND MENUS AT THE TOP OF THE SCREEN ARE USED TO MANIPULATE FILES. COMMAND MENUS AT THE BOTTOM OF THE SCREEN ARE USED TO MANIPULATE SINGLE RECORDS. We will examine the various commands of the Record Command Menu as we proceed through the lessons. Pressing [S] will continue the search, so press [S] to display the the next record containing the name "McKusick". Pressing <Enter> while the command SEARCH is highlighted has the same effect. You may quit the search at any time by pressing <Esc> or [Q] in response to the Record Command Menu. When the search is completed or after you have quit the search, you will be returned to the "Enter key:" prompt at the top of the screen. Step 7 - Using Partial Keys In response to the "Enter Key:" prompt at the top of the screen, press <Esc> to start a new search. Assume that in the last search you did not know whether Mckusick was spelled "McKusick" or "MacKusick". By using the partial key "ckusick", you can find all occurrences 3-5 LESSONS of both spellings. In response to the "Enter Key:" prompt, type [ckusick] <Enter>. The program will search for all words with the letters "ckusick". All references with the name McKusick (or MacKusick if there were such a name in the file) will be found. Step 8 - Using Multiple Keys Records that contain two or more key terms may be found by using the logical operators "and" (&) or "or" (|). The "and" operator is represented by the ampersand (&). The "or" operator is represented by the vertical bar (|). To search for references with the authors Coffey and Walsh, type [coffey&walsh] <Enter> in response to the "Enter Key:" prompt. One reference with both authors will be found. To find references on the subject "urea cycle disorder" by either Moser or Batshaw, type [moser&urea|batshaw&urea] <Enter>. Two references will be found, one by Moser, the other by Batshaw. You have learned how to search a file for one or more search keys. In the next lesson you will learn how to edit a record. 3-6 LESSONS LESSON 2 - Creating and Editing 3by5 FIles Step 1 - Creating a 3by5 File Start from the Main Command Menu. If you have just finished Lesson 2, the Main Command Menu will appear as follows: ___________________________________________________ |Files: P[sample1.3x5] | |Search Window Modify >Files< Print Exit | |Open Info Dir Path Copy Move | |___________________________________________________| Press [F] for the FILES command, the press [O] to OPEN a file. The following message will appear: ___________________________________________________ |Files: | |Open: Primary >Secondary< Teritary Output file | |Open Secondary File | |___________________________________________________| We will open a primary file, so press [P] and the program will prompt you: ___________________________________________________ |Files: | |Open Primary File | |FILE NAME: | |___________________________________________________| Type [trial] <Enter> to open (create) file TRIAL.3X5 and its companion index file TRIAL.MAP. The program displays the message "WAIT" while it tries to open the file. Since the file is not present on the diskette, the program will prompt you: _____________________________________________________ |Files: | |Open Primary File trial.3x5 | |Unable to open file. Do you want to build it? (y/n) | |_____________________________________________________| If you do not want to create a new file (e.g., if you typed the wrong name), press [N]. We want to create a new file, so press [Y] and the following prompt will appear: 3-7 LESSONS ___________________________________________________ |Files: P[sample.3x5] | |Open Primary File trial.3x5 | |Maximum characters per record (32-4800) | |___________________________________________________| The program is prompting you for the number of characters per record. This is an important number. Once you specify it for a file, all records in the file will have a maximum number of characters equal to the number you enter. You may pick any number between 32 and 4800. However, with the current version of 3by5, you can search only the first 1024 characters. Larger record sizes are designed for typing letters, instruction manuals, etc. Type [500] <Enter> to specify a record length of 500 characters. The program will then prompt you for the right margin setting (2 to 77). This will be the standard margin for all records in the file. The program will then create both the source and index files, and then return you to the Main Command Menu: ___________________________________________________ |Files: P[trial.3x5] | |Search Window Modify >Files< Print Exit | |Open Info Dir Path Copy Move | |___________________________________________________| If there were any problems opening the file, the program will inform you of the problem, ask you to press Enter, and then return you to the File Command Menu. Note that the program now informs you on the top line that you have opened a primary file called TRIAL. Step 2 - Adding a Record to a 3by5 File We will now learn how to edit records using file TRIAL. The Main Command Menu should appear as below: ___________________________________________________ |Files: P[trial.3x5] | |Search Window Modify >Files< Print Exit | |Open Info Dir Path Copy Move | |___________________________________________________| 3-8 LESSONS Press the space bar until the command cursor moves to the MODIFY command and press <Enter>. The screen will appear as follows: ___________________________________________________ |Files: P[trial.3x5] | |Search Window >Modify< Files Print Exit | |Modify: P[trial.3x5] | |___________________________________________________| Press [M] to modify the file. Since you have only one file opened,the program will not ask you which file to modify and the following Modify Menu will appear: ___________________________________________________ |Files: P[trial.3x5] | |Add Edit Insert Copy Move Delete | |Add a record to file | |___________________________________________________| Press [A] to add a record to the file. The screen will appear as shown on the next page. Note that at the top of the screen the program informs you "Adding Record # 1". The entire screen will appear as follows: ___________________________________________________ |Files: P[trial.3x5] | | | |Adding Record # 1 in [trial.3x5] | |___________________________________________________| | | | | | | | | | | | | | | |___________________________________________________| | Character count: Line 1 Col 1 | | | |___________________________________________________| The blinking cursor is positioned at the upper left corner of the window. You are now ready to enter text. 3-9 LESSONS Step 3 - Typing New Text Type the following text (remember, type only the characters within the square brakcets, not the brackets): [This is line one] <Enter> [Thas are line two] <Enter> [This is l three] <Enter> The text will appear as shown below: This is line one< Thas are line two< This is l three< Note that when you press <Enter>, the program places a solid left pointing tiangle at the end of the line (represented by "<" in this documentation). Next we will correct the errors in the text.` Step 4 - Overtyping Use the cursor keys to position the cursor on the third character of the second line (the "a" in "thas"). Press [i] to enter the letter "i" where the letter "a" is. The screen will appear as follows: This is line one< This are line two< This is l three< You have learned how to overtype. If you want to change a character, just move the cursor to the original character and type the new character. Step 5 - Deleting one character at a time We will now learn how to delete one character at a time. Position the cursor on the word "are" in the second line and type [is]. The cursor will now be positioned at the letter "e". Press <Del> to delete the letter. The text will now appear as follows: This is line one< This is line two< This is l three< 3-10 LESSONS Step 6 - Inserting one character at a time We will now learn how to insert characters. Position the cursor on the space to the the right of the solitary letter "l". Press <Ins> and the message "INSERT" will be displayed at the bottom left of the screen. Type [ine] and press <Ins> again. The text will appear as follows: This is line one< This is line two< This is line three< In the example above inserting text was confined to one line. The same method is used to insert multiple lines of text. For example, position the cursor to the space to the right of the word "is" in line two. Press <Ins> and type: [a test of character insertion and word wrap. By the time I have typed this far, the cursor will be on the next line.] Press <Ins> to end the insert routine. The program will re-align the text when you press <Ins> again. Position the cursor on the first "c" of the word "character" on the second line. Press <Del> twenty four times and watch the words wrap around onto the line. Step 7 - Saving Your Text Press <Esc> and the Edit Command Menu will appear at the BOTTOM of the screen: ___________________________________________________ |>End< Define Insert Format Search Print Abort | |End editing and save record | |___________________________________________________| Press [E] to save the record. The program will then add the record to the file and automatically take you to the next record to be added (in this case record 2). Add a few more records and when the NEXT EMPTY RECORD appears, 3-11 LESSONS press [A] in response to the Edit Command Menu. This will end the Record Adding Routine. The program will return you to the Modify Command Menu at the top of the screen: ___________________________________________________ |Files: P[trial.3x5] | |>Add< Edit Move Copy Delete | |Add record to current 3by5 file | |___________________________________________________| Now press [E] to edit a record. The program will prompt you: ___________________________________________________ |Files: P[trial.3x5] | |Edit Record: | |Records in File P[trial.3x5]: | |___________________________________________________| Type [35] <Enter> and the program will inform you that the record is not present in the file. Press <Enter> to contine. Now type [1] <Enter> and the program will retrieve and display record 1. You may edit it as you please. See Chapter 5 for more details on editing records. 3-12 LESSONS LESSON 3 - Printing and Outputing to Files In this session you will learn how to selectively print and write records from a file you are searching to an OUTPUT FILE. An Output File is a standard ASCII file that contains records from 3by5 files. Output files can be used to transfer records to word processing programs, editors or computer programs that read ASCII text files (record compressed). Step 1 - Opening a Primary File Start from the Main Command Menu. Open file SAMPLE1 as shown in Lesson 1, then press [F] again, and the file command Menu will appear at the top of the screen: ___________________________________________________ |Files: P[sample1.3x5 | |>Open< Info Dir Path Copy Move | |Open: Primary Secondary Tertiary Output | |___________________________________________________| Press [O] to open a file and the following prompt will appear: ___________________________________________________ |Files: P[sample1.3x5] | |Open: Primary >Secondary< Tertiary Output | |Open Secondary File | |___________________________________________________| Note that the program defaults to opening a Secondary file since you already have a primary file opened. We will open an Output file, so press [O]. The program will then ask you for the name of the file: ___________________________________________________ |Files: P[sample1.3x5] | |Enter the name of the output file: | |Press <Enter> for sample1.out | |___________________________________________________| The Auto Help Line informs you that pressing <Enter> alone will assign the name of the first opened 3by5 file to the output file, but will give it the extension OUT. Press <Enter> and the screen will appear as follows: 3-13 LESSONS ___________________________________________________ |Files: P[sample1.3x5] | |Output file is [sample1.out] | |(A)dd to present file contents or (D)elete old | | and create a new file? | |___________________________________________________| If you already had an output file called SAMPLE1.OUT and wanted to add (append) records to it, you would press [A]. If the file SAMPLE1.OUT existed, but you wanted to start anew, you would press [D] to delete any old records in the file. In our case, the Output File SAMPLE1.OUT has just been created, so it does matter whether you press [A] or [D]. (Press either one to continue). The following prompt will appear: "Do you wish to route all records written to disk to printer also? (Y/N)?" Press [N]. The program will display the message "WAIT" and open the output file. If there were any errors in opening the output file, you will be informed, otherwise you will be returned to the Main Command Menu: ___________________________________________________ |Files: P[sample1.3x5] O[sample1.out] | |Search Window Modify Files Print Exit | |Open Info Dir Path Copy Move | |___________________________________________________| The message "O[sample1.3x5]" informs you that the name of the file to which you will be transferring records is SAMPLE1.OUT. It has the same name as the source file, but the extension OUT. Step 3 - Writing to an Output File We will now search for a few references and write certain ones to the output file. Press <Esc> to return to the Main 3-14 LESSONS Command Menu; the press [S] to begin searching. In response to the message "Enter Key:", type [abbott] <Enter>. When the first reference with the name "Abbott" is displayed, the Record Command Menu will be displayed at the bottom of the screen. Press [W] to write the currently displayed record to the Output File. You will briefly see the message "writing" in the lower right corner of the screen. This message is to inform you that the record is being written to disk. If you should press [W] again, a second copy of the record will be written. If you have an IBM or Epson dot matrix printer attached to your machine, press [P], and a copy of the current record will be printed. Now press [S] to continue the search, and the program will return you to the "Enter Key:" prompt since there are no other records with the name "Abbott". In response to the "Enter Key:" prompt, type [murphy] <Enter>. The first reference with the name "Murphy" will be displayed. Press [W] to write the reference to the output file, then press [S] to continue the search. The second reference with the name "Murphy" will be displayed. It is not one that we will copy to the output file, so press [S] to continue the search. The third reference with the name "Murphy" will appear. Press [W] to write the reference to the output file and then press [S]. No other references will be found, and you will be returned to the top of the screen. In response to the "Enter Key:" prompt, press <Esc>. The Main Command Menu will appear. Press [E] to EXIT to DOS. Then press [Y] to confirm that you want to exit to DOS. 3by5 will close all files and return to DOS and the "A>" prompt will appear. In response to the DOS "A>" prompt, type [type sample1.out] and the contents of the output file will be displayed on the screen. You may import the output file into a word processor document and edit it. 3-15 LESSONS LESSON 4 - Multiple Windows and Files In this lesson you will learn how to split the screen display into windows and open several 3by5 files at one time. The Windows Command allows you to: 1. Specify the number of windows (currently one or two). 2. Clear the windows. 3. Direct you search display of a file to either the top or bottom window. 4. Specify whether the window will be cleared before each record is displayed or whether previously displayed records are scrolled upward as new records are displayed (suitable for references and other short records). Step 1 - Creating Multiple Windows First open file SAMPLE1 as shown in Lesson 1. After the file is opened, the File Command Menu will appear again: ___________________________________________________ |Files: P[sample1.3x5] | |>Open< Info Dir Path Copy Move | |Open: Primary Secondary Tertiary Output | |___________________________________________________| Press [O] to open another file. The screen will appear as follows: ___________________________________________________ |Files: P[sample1.3x5] | |Open: Primary >Secondary< Tertiary Output | |Open Secondary File | |___________________________________________________| Note that the command cursor is positioned at the word Secondary. The program always positions the Command Indicator to the first unopened file. Press [S] and the program will ask you for the name of the secondary file. Type [sample2] <Enter> and the program will open the 3by5 source file SAMPLE2.3x5 and its companion 3-16 LESSONS index file SAMPLE2.MAP. The screen will now appear: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |Search Window Modify >Files< Print Exit | |Open Info Dir Path Copy Move | |___________________________________________________| We will now set the number of windows. Press [W]. The screen will appear as follows: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |>Clear< Set Direct Format | |Clear window | |___________________________________________________| ` Move the Command Indicator to the Set Command by pressing the space bar once. The screen will now look like this: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |Clear >Set< Direct Format | |Set window number and size | |___________________________________________________| Press [S], and the program will prompt you for the number of screens: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |Number of windows (1-2): | | | |___________________________________________________| You may press either "1" or "2" to open one or two windows. If you press "1", one window will be created and cleared, and then you will be returned to the Main Command Menu. We will create two windows so press [2]. The program will prompt you: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |Number of lines in top window (1-14): | | | |___________________________________________________| 3-17 LESSONS You may type in any number from 1 to 14 and then press <Enter>. The program will set both top and bottom windows. Type [7] <Enter> to set the top window to seven lines. The screen will appear as follows: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |>Clear< Set Direct Format | |Clear window | | _________________________________________________ | || || || || || || || || || || ||-------------------------------------------------|| || || || || || || || || || || ||_________________________________________________|| | | | | |___________________________________________________| We will now direct the search display of SAMPLE1 to the top window and that of SAMPLE2 to the bottom window. Press [D] to direct the output. The screen will appear as follows: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |Display [sample1.3x 5] to (T)op/(B)ottom window | | | |___________________________________________________| Press [T] to direct the display of the file SAMPLE1 to the top window. The program will the prompt you: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |Display [sample2.3x5] to (T)op/(B)ottom window | | | |___________________________________________________| Press [B] to direct the display of file SAMPLE2 to the bottom window. 3-18 LESSONS The Window Command Menu will appear: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |>Clear< Set Direct Format | |Clear window | |___________________________________________________| Press <Esc> to display the Main Command Menu and you will be ready to begin searching and editing. Press [S] to begin a search and the following screen will appear: ___________________________________________________ |Files P[sample1.3x5] S[sample2.3x5] | |Search: >Primary< Secondary Tertiary All | |Search Primary File | |___________________________________________________| Press [A] to search all opened files. The "Enter Key:" prompt will appear: Type [mckusick] <Enter>. The program will begin its search for records with the name McKusick. Press [S] each time a record is found and displayed in file SAMPLE1. When the search of the primary file (SAMPLE1) is completed, the program will prompt you: ___________________________________________________ |End of Search of file P[sample1.3x5] Press <Enter>| | to continue | |___________________________________________________| Press <Enter> and the program will find the first record in SAMPLE2 that contains the name McKusick. DO NOT press [S] or <Enter> at this time. Press [E] to edit the record that has just been displayed. You may edit the record in any manner you wish. When you are finished editing, press <Esc>, then [E] to end the editing process and save the newly edited record to disk. The Record Command Menu will appear again. Press [S] to continue the search. No other records with the name "McKusick" will be found in the Secondary File and the search will end. 3-19 LESSONS Press <Esc> to return to the Main Command Menu: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |>Search< Windows Modify Files Print Exit | |Search: Primary Secondary Tertiary | |___________________________________________________| We will now open file SAMPLE1 as the Primary and Secondary File. Press [F] for the Files Command. The screen will appear as below: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |>Open< Info Dir Path Copy Move | |Open: Primary Secondary Tertiary Output | |___________________________________________________| Press [O] to open a file and the screen will appear as follows: ___________________________________________________ |Files: P[sample1.3x5] S[sample2.3x5] | |Open: Primary Secondary >Tertiary< Output | |Open Tertiary File | |___________________________________________________| The program assumes that you want to open the next available file. However, we will open SAMPLE1 as the secondary file. Press [S]. The program will then prompt you for the name of the file. Type [sample1] <Enter>. SAMPLE1 will be opened as the Secondary File and both the Primary and Secondary Files will be SAMPLE1: ___________________________________________________ |Files: P[sample1.3x5] S[sample1.3x5] | |Search Window Modify Files Print Exit | |Open Info Dir Path Copy Move | |___________________________________________________| Press [W] for the Window Command. The press [F] for the Window Format Command. The screen will appear as below: ______________________________________________________ |Files: P[sample1.3x5] S[sample1.3x5] | |Display file P[sample1.3x5] in (S)croll/(P)age Format | |______________________________________________________| 3-20 LESSONS Press [S] for Scroll Display in the top window (remember that earlier you directed the display of the Primary File to the top window). The screen will then prompt you: _____________________________________________________ |Files: P[sample1.3x5] S[sample1.3x5] | |Display file S[sample1.3x5 in (S)croll/(P)age Format | |_____________________________________________________| Press [P] for Page Display for the Secondary File. Remember that previously you had directed display of the Secondary File to the bottom window. Finally press [C] to clear all windows. You should now be in the Main Command Menu. Press [S] to begin searching. The program will prompt you as follows: ___________________________________________________ |Files: P[sample1.3x5] S[sample1.3x5 | |Search: >P[sample1.3x5]< All | |Search Primary File | |___________________________________________________| Press [A] to search all files (in this case Primary and Secondary Files). The "Enter Key:" prompt will appear. Type [Mckusick] <Enter>. When the first record is found, the Record Command Menu will be displayed. Press [F] to go FORWARD to the next record. Note that the Forward Command moves you to the next record in the file, regardless of the contents of the record. The record you have moved forward to does not contain the name McKusick. We will edit the record and add the name McKusick. Press [E] to edit the record. Insert the name McKusick somewhere in the record. You may make any other changes and then press <Esc> [E]. The Record Command Menu will then be displayed: _____________________________________________________ |>Search< Edit Forward Backward Goto Print Write Quit | |Continue search | |_____________________________________________________| Press [S] to resume searching. Note that the record you have just edited will be found when you resume searching. 3-21 LESSONS After you have finished searching the Primary File, the program will begin to search the Secondary File. When the first occurrence of the name McKusick is found, the record will be displayed. Press [S] to continue the search, The bottom window will be cleared and the second record with the name McKsuick will be displayed. This is an example of the Page Format (the window is cleared before each record is displayed). 3-22 3by5 COMMANDS CHAPTER 4 - 3by5 COMMANDS Instructions for using each of the 3by5 commands are included in this chapter. The instructions are designed as a reference guide for use after you have worked your way through the 3by5 Lessons in Chapter 3. NOTE: 3by5 is a single program that can be loaded into memory and the diskette then removed. This feature is helpful if you have two large 3by5 files. One may be placed in drive A, the other in drive B. 4.0 MAIN COMMAND MENU The Main Command Menu appears at the top of the screen and is the first command menu that you see when you enter 3by5. The commands are as follows: ___________________________________________________ | | |Search Window Modify Files Print Exit | |___________________________________________________| 4.1 FILES COMMAND ___________________________________________________ | | |Search Window Modify >Files< Exit | |Open Info Dir Path Copy Move | |___________________________________________________| The 3by5 Files Command is entered from the Main Command Menu by pressing [F]. The File Command will appear: ___________________________________________________ | | |Open Info Dir Path Copy Move | |Open Primary Secondary Tertiary Output | |___________________________________________________| The Open Command lets you open a 3by5 file or any ASCII, WordStar or WordPerfect file. Only 3by5 files may be modified from the 3by5 program. The Info Command gives you information about each opened file. 4-1 3by5 COMMANDS The Dir (Directory) Command allows you to determine what files are on a diskette (or the active directory of a hard disk). The Path Command allows you to specify the default disk drive. The Copy and Move Commands are used to transfer records from one file to another. 4.1.1 OPEN COMMAND ___________________________________________________ | | |Open: >Primary< Secondary Tertiary Output | |Open Primary File | |___________________________________________________| You may open up to three 3by5 or other files for searching at one time. Additionally, you may open an Output File that will receive ASCII records from a 3by5 file. An output file can be used to transfer records form a 3by5 file to a wordprocessing document file, Basic data file, etc. The output file is record compressed. If one or more files are already open, press [P], [S] or [T] in response to the above prompt to open a Primary, Secondary or Tertiary file. One of the following prompts will appear: Open Primary File FILE NAME: Open Secondary File FILE NAME: Open Tertiary File FILE NAME: Type in the name of the file that you want to open. If the file is on a disk drive that is not the default DOS drive, include the disk drive using standard DOS file specification (e.g. B:FILE1). If you enter a file name without an extension, the program will assume that the file is a 3by5 file and append the extension "3X5". If the file is NOT a 3by5 file and does not have an extension, place a "." (period) after the file name to indicate that the file has no extension and is not a 3by5 file. For example, "FILE1" will open the file FILE1.3X5, while "FILE1." 4-2 3by5 COMMANDS will open the file FILE1. "FILE1.WS" will open the file FILE1.WS, a WordStar Document File. While the file and its companion index file are being opened, the message "WAIT" will be displayed in reverse video at the right margin of the second line. If the file is found, it will be opened. If the file is not a standard 3by5 file, you be informed of the fact by the program, asked to press <Enter> and then the program will continue. See section 4.1.1.3 for information on opening non-3by5 files. 4.1.1.1 CREATING A 3by5 FILE If you attempt to open a file that does not exist, you will be asked whether you want to build the file: "Unable to open file. Do you want to build the file? (Y/N)." Press [Y] to build the file, [N] to jump back to the Main Command Menu. If you pressed [Y], the program will then prompt you for the record size: "Maximum characters per record: (32 - 4800)" The number you enter will determine the number of characters (bytes) that may be entered into any one record of the file. The program will then prompt you for the default right margin for all records in the file (2 - 77). Type the number and press <Enter>. The program will then build build the standard 3by5 file and its companion index file. The index file will be given the extension "MAP". ONLY THE FIRST 1024 CHARACTERS (BYTES) OF A RECORD MAY BE INDEXED AND SEARCHED. LARGER RECORDS ARE FOR WRITING LETTERS, MANUALS, ETC. 4.1.1.2 INDEXING FILES If the program is able to open a source file, but cannot locate an index file (e.g. a non-3by5 file that has not been indexed, or a 3by5 file without a companion index file), it will prompt you: "Index file? (Y/N)" If you want to work with a 3by5 source file, it must be indexed before it can be opened. Press [Y] to begin the indexing process. You will be return to the Main Command Menu when indexing is complete and the file opened. Non-3by5 files do not need to be indexed to be opened. 4-3 3by5 COMMANDS 4.1.1.3 OPENING A NON-3by5 FILE You may open and search (but not edit) a standard ASCII text file or a WordStar or WordPerfect file. If the program opens the file and finds that is is not a standard 3by5 file, it will attempt to open an index file for the file. If you have previously indexed the file, the program will open both files and return you to the File Command Menu. If the file has not been indexed the program will ask whether you want it indexed: "Index file? (Y/N)" If you press [N], the program will allow you to search the file, but the searches will be slow. After pressing [N] you will be returned to the File Command Menu. Regardless of whether or not you index the file, file searches of non-3by5 files are limited to blocks of 256 characters or less. If you press [Y], the program will build an index file with the same name as the source file on the same drive as the source file, but with the extension "MAP". You will be prompted for the file type: "File type: 1. ASCII 2. WordStar 3. WordPerfect Press [1], [2] or [3] to indicate the file type. 4.1.1.4 OPENING AN OUTPUT FILE You may open an ASCII output file to which you may transfer records found during your search. NOTE: The Copy and Move Commands are used to copy and move records from one 3by5 file to another. In response to the prompt: ___________________________________________________ |Open: >Primary< Secondary Tertiary Output | |Open Primary File | |___________________________________________________| Press [O] for Output File. The following prompt will appear: --------------------------------------------------- |FILE NAME: | |Press <Enter> for xxxxxxx file | |___________________________________________________| Where xxxxxx is the name of the first opened 3by5 file. 4-4 3by5 COMMANDS The program is prompting you for the Output File name. If one or more 3by5 files are opened, pressing <Enter> alone will give the output file the same name as the first opened 3by5 file and assign it the extension "OUT". Alternatively, you may assign a drive, name and extension to the Output File. If there are any errors in opening the file you will be informed by the program. 4.1.1.5 CLOSING FILES Whenever you exit from 3by5 by using the Exit Command, all opened files are automatically closed. If you open a Primary File and there is already another file opened as the Primary File, the opened file is first closed and then the new primary file opened. The same applies to Secondary and Tertiary Files. To close a Primary File without opening another, just open a a Primary File and press <Enter> in response to the "FILE NAME:" prompt. The presiously opened Primary File will be closed. The same applies to Secondary and Tertiary Files. 4.1.2 INFO (Information) COMMAND ___________________________________________________ | | |Open >Info< Dir Path Copy Move | |Information about opened files | |___________________________________________________| Pressing [I] in response to the Files Command Menu will give you information about each file that you have opened. You will be informed of the type of the file (3by5 or non-3by5), the number of bytes per record and the number of records in the file. 4-5 3by5 COMMANDS 4.1.3 DIR (Directory) COMMAND ___________________________________________________ | | |Open Info >Dir< Copy Move | |List of files in directory | |___________________________________________________| In response to the File Command Menu press [D] to obtain a listing of files in any directory. The program will prompt you: "Directory Search Pattern: *.*" If you press enter, all files on the default disk (or directory) will be listed. You may specify the directory search pattern. For example, "B:FILE*.*" will list all files on drive B that begin with the letters "FILE". 4.1.4 PATH COMMAND ___________________________________________________ | | |Open Info Dir >Path< Copy Move | |Specify dirve and path for files | |___________________________________________________| The Path Command allows you to specify the default disk drive that will be prefixed to any file specification that does not contain a disk drive. For example, if the default disk drive is "C" and you type "FILE1" in response to the FILE NAME prompt, the program will attempt to open the file C:FILE1. If you type "B:FILE1, the program will attempt to open the file B:FILE1. The default drive specification is overridden when you specify the disk drive. 3by5 currently does NOT allow you to specify a search path through directories. Press [P] to specify the default drive. The following message will appear: "Current default drive: Enter new Default drive: " Type the letter of the disk drive that you want for your default drive. Pressing <Enter> will give you the same default disk drive as that used by DOS. 4-6 3by5 COMMANDS 4.1.5 COPY AND MOVE COMMANDS The Copy Command of the File Command Menu is used to copy records from one file (source file) to another (destination file). The records in the source file are not affected. The Move Command performs a similar function, but deletes the contents of the source records that are moved to the destination file. Press [C] or [M] to Copy or Move records. The program will then prompt you for the source and destination files. After you have entered that information, the program will prompt you for the range of records in the source file to be copied/moved to the destination file. Then it will prompt you for the record number in the destination file at which to start the transfer. 4-7 3by5 COMMANDS 4.2 SEARCH COMMAND ___________________________________________________ | | |>Search< Windows Modify Files Print Exit | |Search: Primary Secondary Tertiary All | |___________________________________________________| Once a file has been opened, you may search it for any combination of three or more characters (up to 60) by pressing [S] in response to the Main Command Menu. If there are two or more files opened, the program will prompt you: ___________________________________________________ | | |Search: >P[xxxxxxxx]< S[xxxxxxx] T[xxxxxxx] All | |Search Primary File | |___________________________________________________| Press [P], [S] or [T] to select a specific file. Press [A] to specify all files. If only one file is opened, the above prompt will be bypassed. Next, the following message will appear: ___________________________________________________ | | |Enter Key: | |Press <Esc> for Menu; <F3> prior key; <F4> browsing| |___________________________________________________| Pressing <Esc> will return you to the Main Command Menu. Pressing <F3> will restore the last search key (if any) of the current session. The key may be edited by using the insert and delete keys and by overtyping. Pressing <F4> will allow you to browse (move forward and backward) through a file. To initiate a search, type in a search key and press <Enter>. For example, typing [pascal] <Enter> will initiate a search for all records that contain the name Pascal. 4-8 3by5 COMMANDS 4.2.1 SINGLE SEARCH KEYS A single search key must be three or more characters in length (a space is not considered a character). For example "cat", "cart", "carton" and "arto" are all valid search keys that will locate the word "carton". "It" is not a valid search key since it has less than three letters. Any one search key may be up to 20 characters in length. 4.2.2 MULTIPLE SEARCH KEYS Records that contain two or more keys may be found by using the logical operators "and" (&) or "or" (|). The "and" operator is represented by the ampersand (&). The "or" operator by the vertical bar(|). For example, to search for records with the terms "computer" and "Basic", type [computer&basic] <Enter> in response to the "Enter Key:" prompt. Only records with both terms terms "computer" and "Basic" will be found and displayed. Typing [computer|basic] <Enter> will locate all records that contain either the term "computer" or "Basic" or both "computer" and "Basic". Typing [computer&basic|computer&fortran] <Enter> will locate all records that contain either the terms "computer" and "Basic", "computer" and "FORTRAN", or both "computer" and "Basic" and "computer" and "FORTRAN". You may have up to five search keys for each search group. A search group is one or more search keys separated from another group of search keys by a "|". For example, the search key [cat&dog|fox&hound&chicken] contains two search groups: "cat&dog" and "fox&hound&chicken". 4-9 3by5 COMMANDS 4.3 WINDOW COMMAND ___________________________________________________ | | |Search >Window< Modify Files Print Exit | |Clear Set Direct Format | |___________________________________________________| The Window Command allows you to clear the windows, set the number of windows to one or two and define the size of the windows when there are more than one, direct the screen display for eidting or searching to a particular window, and define the format in which records are displayed. In response to the Main Command Menu, press [W] for the Window Command. 4.3.1 CLEAR COMMAND ___________________________________________________ | | |Clear Set Direct Format | |Clear Windows | |___________________________________________________| Press [C] and all active windows will be cleared. You will be returned to the Window Command Menu. 4.3.2 SET COMMAND ___________________________________________________ | | |Clear Set Direct Format | |Set window number and size | |___________________________________________________| In response to the Window Command Menu, press [S] for the Set Command. The following prompt will appear: "Number of windows: (1/2)" You may press [1] or [2]. Pressing [1] will set one window and return you to the Main Command Menu. Pressing [2] will result in the following prompt: 4-10 3by5 COMMANDS "Number of lines in the top window (2-14):" Enter a number between 2 and 14; then press <Enter>. The number of line in the bottom window will be automatically determined, and you will be returned to the Main Command Menu. 4.3.3 DIRECT COMMAND ___________________________________________________ | | |Clear Set >Direct< Format | |Direct file display to a window | |___________________________________________________| The Direct Command allows you to direct the display/editing of a file to a particular window. After setting the number of windows using the Set Command, press [D] for the Direct Command. For each file you have opened, the program will prompt you: "Display file [xxxxxx] to (T)op/(B)ottom window: " Where xxxxxx is stands for the name of the file. Press [T] for the top window, [B] for the bottom window. 4.4.4 FORMAT COMMAND ___________________________________________________ |Clear Set Direct >Format< | |Format for search display | |___________________________________________________| The Format Command for windows allows you to specify the way in which 3by5 displays records during a search. You may use either the: Scroll Format: As each record is displayed, the previously displayed records are scrolled off the top of the screen. Page Format: Before each record is displayed, the window is cleared. The Scroll Format is best for small recrods such as references 4-11 3by5 COMMANDS where you may want to see as many of the records at a time as possible. The Page Format is best for large records that occupy more than 10 lines or records that are formatted in a highly structured way (e.g. Name, Street, City, State and Zip Code on separate lines). To specify the display format, press [F] in response to the Window Command Menu. The following prompt will appear: "Display [xxxxxxxx] is (S)croll/(P)age format:" Where xxxxx is the name of the file. Press [S] for Scroll Format, [P] for Page Format. The program will loop through all opened files so that you may set the display format for each. 4-12 3by5 COMMANDS 4.4 MODIFY COMMANDS ___________________________________________________ | | |Search Window >Modify< Files Print Exit | |Add Edit Insert Copy Move Delete | |___________________________________________________| The Modify Command Menu allows you to modify any opened 3by5 file. You may add records, edit pre-existing records, copy or more records within a file and delete exist records. The Insert Command currently performs the same funtion as the Add Command. In response to the Main Command Menu, press [M] for the Modify Command Menu. If more than one file is opened, the promgram will prompt you as follows: "Modify P[xxxxxxx] S[xxxxxxxx] T[xxxxxxx] " Press [P], [S] or [T] to select the file to be modified. 4.4.1 ADD COMMAND ___________________________________________________ | | |>Add< Edit Insert Copy Move Delete | |Add a record to current 3by5 file | |___________________________________________________| The Add Command allows you to add (append) new records to a file. Press [A]. The program will clear the appropriate window and you may start to enter a new record. The second line will display the message: "Adding record # xxxx in [yyyyyyy]" Where xxxx is the number of the reocrd that will be added and yyyy is the name of the file to which the record will be added. See Chapter 5 for information on editing records. When you are finished editing a record, you may save it or quit the editing process and not save the record. If you save the new record the program will automatically clear the screen and you will be ready to enter the next record. This will continue until you quit editing. 4-13 3by5 COMMANDS 4.4.2 EDIT COMMAND ___________________________________________________ | | |Add >Edit< Insert Copy Move Delete | |Edit a record | |___________________________________________________| This command allows you to edit a record that is already in a 3by5 file. Press [E]. The program will prompt you.: ___________________________________________________ | | |Edit Record Number: | |Records in file [xxxxx] yyyy | |___________________________________________________| The program informs you of the name of the file you are editing (represented by xxxxx) and the number of records (yyyy) in the file. Type the number of the record you want to edit and press <Enter>. The program will inform you if the record is not present in the file. If the record is present, it will be retrieved and displayed. You may then edit the record (see Chapter 5 for instructions on using the editor). 4.4.3 INSERT COMMAND ___________________________________________________ | | |Add Edit >Insert< Copy Move Delete | |Insert (add) record to current 3by5 file | |___________________________________________________| The Insert Command currently performs the same function as the Add Command. In future versions of 3by5 it will be used to insert a new record between adjacent records. 4.4.4 COPY and MOVE COMMANDS ___________________________________________________ | | |Add Edit Insert >Copy< Move Delete | |Copy a Record | |___________________________________________________| 4-14 3by5 COMMANDS The Copy Command allows you to copy one or more records form one place (source) to another (destination) WITHIN a file. The Move Command performs the same function, but deletes the contents of the source records. Press [C] or [M] to Copy or Move a group of records. The program will prompt you: "WITHIN [filename] COPY RECORDS" Enter the first record number of the group to be copied or moved and press <Enter>. The program will the prompt you: "WITHIN [filename] COPY RECORDS xxx to " Now enter the last record to be copied or moved and press <Enter>. If you want to copy or move only one record, the first and last record should be the same. The program will then prompt you: "WITHIN [filename] COPY RECORDS xxx to yyy TO" Enter the destination record number for the first record to be transferred. For example, the following command "WITHIN [filename] COPY RECORDS 23 to 45 TO 145 will copy records 23 to 45 to records 145 to 157. There is no need to to specify the last destination record since the program determines the number for you. As the records are copied, the program will display: "Copying record xxxx to yyyy" The above insrtuctions for Copying records apply to Moving records. 4.4.5 DELETE COMMAND ___________________________________________________ | | |Add Edit Insert Copy Move >Delete< | |Delete a record | |___________________________________________________| The Delete Command allows you to delete (erase) the contents 4-15 3by5 COMMANDS of a record. The space occupied by the record in the file remains present in the record. Press [D]. The program will prompt you: ___________________________________________________ | | |Delete Record Number: | |Records in file [xxxx] yyyy | |___________________________________________________| The program informs you of the name of the file you are modifying (recpresented by xxxx) and the number of records in the file (represented by yyyy). Type the number of the record you want to delete and present <Enter>. 4.5 PRINT COMMAND ___________________________________________________ | | |Search Window Modify Files >Print< Exit | |Print records | |___________________________________________________| The print command allows you to print any reange of records form a 3by5 file. Press [P] to print a record. The program will then prompt you: ___________________________________________________ | | |Print P[xxxxxxxx] S[xxxxxxxxx] T[xxxxxxxxx] | |Print from Primary File | |___________________________________________________| Press [P], [S] or [T] to select the file you want to print from. The program will then prompt you for the range of records to be printed. If you have selected Page Display Mode with the Windows command, the program will advance the printer to the top of the next page after printing a record. 4-16 3by5 COMMANDS 4.6 EXIT COMMAND ___________________________________________________ | | |Search Windows Modify Files Print >Exit< | |Exit from 3by5 | |___________________________________________________| The Exit Command is used to end a 3by5 session and exit to the operating system. If any files are opened, it is important to always Exit when you are finished since Exiting automatically closes all files. IF YOU HAVE ANY OPEN 3by5 FILES, DO NOT REMOVE THE SOURCE FILE DISKETTE(S) UNTIL YOU HAVE EXITED FROM THE PROGRAM. The above restriction applies only to 3by5 source file diskettes. The 3by5 program diskette may be removed form the disk drive as soon as the program is loaded since the 3by5 program is completely loaded into memory. In response to the Main Command Menu press [E] for the Exit Command. The message will appear: ___________________________________________________ | | |>No< Yes | |No, do not exit | |___________________________________________________| If you press <Enter> of [N] you will be returned to the Main Command Menu. If you press the space bar, the follwoing prompt will appear: ___________________________________________________ | | |No >Yes< | |Yes, exit 3by5 | |___________________________________________________| Pressing <Enter> will exit to DOS as will pressing [Y]. Alteratively, pressing [N] will return you to the Main Command Menu. 4-17 RECORD COMMANDS CHAPTER 5 - RECORD COMMANDS ______________________________________________________ |>Search< Edit Forward Backward Goto Print Write Quit | |Continue search | |______________________________________________________| The Record Command Menu appears at the bottom of the screen whenever you are searching or browsing through a file. 5.1 SEARCH COMMAND ______________________________________________________ | | |>Search< Edit Forward Backward Goto Print Output Quit | |Continue Search | |______________________________________________________| While searching, the above Record Command Menu will bve displayed after a record with the required key is found and displayed. Press [S] to continue the search after each record in displayed. 5.2 EDIT COMMAND ______________________________________________________ | | |Search >Edit< Forward Backward Goto Print Write Quit | |Edit current record | |______________________________________________________| The Edit Command allows you to edit the current record. Press [E] to edit the last record that has been displayed. See Chapter 6 for instruction on editing. 5.3 FORWARD AND BACKWARD COMMANDS ______________________________________________________ | | |Search Edit >Forward< Backward Goto Print Write Quit | |______________________________________________________| 5-1 3by5 COMMANDS The Forward Command moves you Forward one record each time you press [F]. The Backward command moves you back one record at a time. The Backward Command does no allow you to move backward in a non-3by5 file. 5.4 GOTO COMMAND The Goto Command allows you to jump directly to any record in the file. Just press [G]. The program will then prompt you for the number of the record. 5.5 PRINT COMMAND ______________________________________________________ | | |Search Edit Forward Backward Goto >Print< Write Quit | |Print current record | |______________________________________________________| The Print Command allows you to print the most recently displayed record to your computer's printer. Each time you press [P], the record last displayed will be printed. 5.5 WRITE COMMAND ______________________________________________________ | | |Search Edit Forward Backward Goto Print >Write< Quit | |Write current record to output file | |______________________________________________________| The Write Commandd allows you to copy records from a 3by5 file to a record compressed ASCII file. The Output file must be opened or an error error will occur and you will be notified of the problem. Each time you press [W] the program will display the message "writing" in the lower right hand corner of the screen. Each time you press [W] a copy of the current record is written to the Output File. 5-2 3by5 COMMANDS 5.6 QUIT COMMAND ______________________________________________________ | | |Search Edit Forward Backward Goto Print Write >Quit< | |Quit search | |______________________________________________________| The Quit Command allows you to stop a search after a record has been displayed. Press [Q] to end the search. Alternatively, you may press <Esc> to stop a search. 5-3 3by5 EDITOR CHAPTER 6 - 3by5 EDITOR 3by5's editor is based on the well known Wang and Symphony word processors. Features include: word wrap, insert and delete functions with automatic alignment of text, numerous cursor control commands and block copy/move/erase commands. It is not, however, a full word processor. When you first enter the editor, the cursor will be at column one of line one. The window in which you are editing will have a double-line border around it. The right margin will be indicated by a << mark on the top and bottom lines of the window border. At the bottom of the screen, the character count (number of characters in the record), line number and column number will be displayed. The editor allows you to enter up to 60 lines of text per record, regardless of the number of characters (bytes) per record. If you enter more characters than the record will hold, the program places an asterisk (*) to the right of the character count. While editing text, you may execute a command by pressing <Esc>. This will cause the Edit Command Menu to be displayed at the bottom of the screen (see Section 5.6 for information on using the Edit Command Menu). 6.1 ADDING TEXT To enter text in a new record or at the end of text in a record, just type the characters you want to enter. Words that extend beyond the right margin are automatically wrapped down to the next line. Pressing <Enter> indicates the end of a paragraph (or block of text) and is indicated by a solid, left-pointing triangle. Text will not wrap around an end of paragraph mark. You may type over text by moving the cursor with the cursor control keys to the appropriate position, and then type the new text you want to enter. If an end of paragraph (solid, left-facing triangle) is encountered while over-typing, the program will jump to Insert Mode (see below). 6.2 DELETING TEXT A CHARACTER AT A TIME You may delete the character at the current cursor postion by pressing <Del>. Each time you press <Del>, a charcter is deleted. Text is automatically realigned as you delete characters. 6-1 3by5 EDITOR 6.3 INSERTING TEXT The 3by5 editor is always in the overtype mode except when you press the <Ins> key or type past the End of Paragraph marker (solid, left-pointing triangle). At the left bottom corner of the screen the message "Insert" will be displayed. As you enter text in the Insert Mode, the text to the right of the cursor is shifted to the right until the end of the line is reached. At that point, any text to the right of the cursor is shifted down to the next line, and you may continue to type. You exit the Insert Mode anytime you press a cursor control button, press the back space key, <Del> or <Ins>. Text below the cursor will then be realigned automatically. 6.4 BACK SPACE Pressing the back space key deletes the character under the cursor and moves the cursor to the left one character. 6.5 MOVING THE CURSOR The four arrow keys (up, down, left and right arrows) move the cursor one character or line at a time. When the cursor reaches the end of a line, it does NOT automatically wrap down to the next line. Additionally, the 3by5 editor allows you to move the cursor by using the following keys: Home - moves the cursor to the beginning of the current line. End - moves the cursor to the end of the current line. Pg Up - moves the cursor to the line 1 column 1 of the current record. If you press <Pg Up> twice, the current record will be saved and you will be positioned to the top of the previous record. Pg Dn - moves the cursor to the last column of the last line of text of the current record. If you press <Pg Dn> twice, the current record will be saved and you will be positioned to the top on the next record. 6-2 3by5 EDITOR 6.6 EDIT COMMAND MENU At anytime you are editing text, you may invoke the Edit Command Menu by pressing <Esc>. The following menu will appear at the bottom of the screen: ___________________________________________________ |>End< Define Insert Format Search Print Abort | |End editing and save current record | |___________________________________________________| To continue editing, press <Esc> to return to the last position you were at in the editor. 6.6.1 END COMMAND The End Command ends the editing process, saves the edited record to disk and returns you to the Modify Command Menu at the top of the screen. If you had entered the editor through the Add Command, the program will automatically bring you back to the editor and allow you to enter the next record. Another method of saving changes to a record without using the Edit Command Menu, is to press <Ctrl><PgDn>. This will save the current record and position you to the top of the next record. Press <Ctrl><PgUp> will save the record and move you to the top of the previous record. 6.6.2 DEFINE COMMAND The Define Command is used to define a block of text that will be Copied, Moved or Erased. Press [D] to define a block of text. The following message will appear at the bottom of the screen: "Define block. Then press <Enter>, (C)opy, (M)ove or (E)rase" Move the cursor to the left and/or downward to highlight (display in reverse video) the text you want to define. Move the cursor to the right and/or upward to remove the highlight. The highlighted text is the block of text defined for the operation. If you decide that you do not want to copy, move or erase a block of text just press <Esc>. Otherwise, after you have defined the block of text, press <Enter> and the Copy/Move/Erase Command Menu will appear: 6-4 3by5 EDITOR ___________________________________________________ |>Copy< Move Erase | |Copy highlighted text | |___________________________________________________| From this menu you will instruct the program to copy, move or erase the block of text you have defined (highlighted). An alternative method of copying, moving or erasing text that bypasses the Copy/Move/Erase Menu, is to press [C], [M] or [E] after you have defined the block of text, but before you press <Enter>. 6.6.2.1 COPY COMMAND If you press [C] in response to the Copy/Move/Erase Command Menu, the highlight will be removed, and at the bottom of the screen you will be prompted: "Position cursor for text insertion and press <Enter>" You may position the cursor anywhere within the record and then press <Enter>. The text that you previously defined will be inserted starting at the cursor. You may abort the process by pressing <Esc>. However, the block of text that you defined by highlighting, remains in a temporary buffer. By using the INSERT COMMAND of the Edit Command Menu, you may move the defined block of text to one or more other records. Each time you define a block of text and press [C] for copy or [M] for move, the temporary buffer is erased and the newly defined block of text is placed in the temporary buffer. 6.6.2.2 MOVE COMMAND The Move Command of the Copy/Move/Erase Command Menu works the same way as the Copy Command, except the highlighted text is erased before you insert it in its new postion. 6.6.2.3 ERASE COMMAND After you have defined a block of text, press [E] or <Enter> [E] to erase the block of text. CAUTION, once you delete a block of text, you cannot restore the original text. 6-4 3by5 EDITOR 6.6.3 INSERT COMMAND The Insert Command allows you to insert a previous defined block of text at the current cursor postion. The block of text must have been previously defined by using the block Copy or Move commands. The Erase Command does not store any text in the temporary buffer. The Insert Command can be used to move a block of text (saved in the temporary buffer with the Copy or Move Command) from one record to one or more other records (within the same file or from one file to another). 6.6.4 FORMAT COMMAND The format command allows you to set the right margin for record you are editing. Use this command if you want the right margin of the record to be different from that you set when you created the file. 6.6.5. SEARCH COMMAND While editing, you may search the same file or another open file. After you have finished you search, you will be returned to the Editor. 6.6.6 PRINT COMMAND The Print Command allows you to print the current record you are editing. Each time you press [P] one copy of the record will be printed. The record will be printed in Scroll or Page format as defined by the Window Format Command. If you have a printer buffer or a software spooler, you will not have to wait for the printer to finish before you move on to another task. 6.6.7 ABORT COMMAND The Abort Command restores the record to its original state before you began to edit it, and then returns you to the Modify Command Menu. 6-5 6-6 FUTURE FUTURE SOFTSHELL RELEASES The 3by5 program you have received is an Adware product from Softshell Corp., a publisher of vertical market programs for medical and scientific uses. Its purpose is to establish recognition in the market place for Softshell products. We hope that you find the 3by5 program helpful. You may make copies for yourself or for others, but may not charge for distributing the program. We request that each user of the program send in a registration form (see the last page of this documentation). After we have registered 10,000 copies of 3by5, we will publish an updated version. Aside from correcting any flaws in the current version, we will add enhancements requested by owners of 3by5 Version 1.0. As with all advertising, it is important to have good demographic data on the population we are reaching. Therefore, we request that every user of 3by5 send in a registration form. The information will be used internally by Softshell Corp. to plan future products and will not be released to any other group. If there is enough interest, our next product will be either a full word processor or a database management system. Any suggestions or requests from users of 3by5 will be appreciated. LIMITED WARRANTY This program, instruction manual and reference materials are sold "As Is" without warranty as to the performance, merchantability, or fitness for any particular purpose. The entire risk as to the results and performance of this program is assumed by the customer. However, to the original customer only, the publisher warrants the magnetic diskette on which the program is recorded to be free from defects in materials and faulty workmanship under normal use for a period of ninety days from the date of purchase. If during this ninety day period the diskette should become defective, it may be returned to the publisher for a replacement without charge (except for postage and handling) provided the customer has previously sent in customer's limited warranty registration form to the publisher or sent proof of purchase of the program. Customer's sole and exclusive remedy in the event of a defect is expressly limited to replacement of the diskette as provided above. If failure of a diskette has resulted from accident or abuse, the publisher shall have no responsibility to replace the diskette under terms of this limited warranty. Any implied warranties relating to the diskette, including any implied warranty of fitness for a particular purpose is limited to a period of ninety days from date of purchase. Publisher shall not be liable for indirect, special or consequential damages resulting from the use of this product. Some states do not allow the exclusion or limitation of incidental or consequential damages, so the above limitations may not apply to customer. This warranty gives the curtomer specific legal rights, and the original customer may also have other rights that vary from state to state. SOFTSHELL SOFTWARE LICENSE Softshell grants to customer a non-exclusive, paid-up license to use the Softshell Corp. software, subject to the following provisions: A. Except as otherwise provided in this software license, applicable copyright laws shall apply to the software. B. Title to the medium on which the software is stored or trans- ferred to customer. C. Customer shall not make, manufacture or reproduce modified or unmodified copies of software for resale. D. Customer may distribute unmodified copies of the software free of charge to the party receiving the software. E. All copyright notices shall be retained on all copies of the software. INDEX Section Add Command ........................................... 4.4.1 Adding records ........................................ 4.4.1 Browse Command ........................................ 4.2 Building a 3by5 file .................................. 4.1.1.1 Copy Command (between files) .......................... 4.1.5 Copy Command (within a file) .......................... 4.4.4 Copy Command (within a record) ........................ 6.6.2.1 Delete Command (delete a record) ...................... 4.4.5 Direct (Window) Command ............................... 4.3.3 Directory (Files) Command ............................. 4.1.3 Edit Command .......................................... 4.4.2 Editing records ....................................... 6.1 Erase Command (erase text within a record) ............ 6.6.2.3 Exit Command .......................................... 4.6 File, 3by5 ............................................ 4.1.1 Files Command ......................................... 4.1 Information Command ................................... 4.1.2 Insert Command (insert a block of text) ............... 6.6.3 Insert Command (insert a record) ...................... 4.4.3 Modify Command ........................................ 4.4 Move Command (between files) .......................... 4.1.5 Move Command (within a file) .......................... 4.4.4 Move Command (within a record) ........................ 6.6.2.2 Non-3by5 files ........................................ 4.1.1.3 Open Command .......................................... 4.1.1 Path (Files) Command .................................. 4.1.4 Print Command ......................................... 4.5 Printing while editing a record ....................... 6.5.6 Saving a record (End Command) ......................... 6.6.1 Search Command ........................................ 4.2 Search key ............................................ 4.2.1 Set (Window) Command .................................. 4.3.2 Window Command ........................................ 4.3 Write Command (write to Output File) .................. 6.5 3by5 VERSION 1.0 REGISTRATION FORM Model No. 1100 Name: ________________________________________________ Street: ________________________________________________ City: ________________________________________________ State: __________________________ ZIP _____________ I use 3by5 primarily for: [] references [] research notes [] patient records [] other (please comment) I would like to see the following features added to 3by5: Mail to: Softshell Corporation P.O. Box 18522 Baltimore, MD 21237